

package com.hazelcast.sql.impl;

import com.hazelcast.sql.SqlResult;
import com.hazelcast.sql.SqlRow;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

public abstract class AbstractSqlResult implements SqlResult {

    public abstract QueryId getQueryId();

    /**
     * Whether the result is possibly infinite, i.e. it may have an infinite number of rows, and creation of the next row
     * may take infinite time. Set to {@code true} for Jet queries.
     *
     * @return {@code true} if the result is possibly infinite, {@code false} otherwise.
     */
    public abstract boolean isInfiniteRows();

    /**
     * Returns index of the query parameter that should be used as a partition
     * key to determine the coordinator for future executions of the same query,
     * or -1 if there's no such parameter.
     */
    public abstract int getPartitionArgumentIndex();

    @Nonnull
    @Override
    public abstract ResultIterator<SqlRow> iterator();

    /**
     * Closes the result, releasing all the resources.
     *
     * @param exception exception that caused the close operation or {@code null} if the query is closed due to user request
     */
    public abstract void close(@Nullable QueryException exception);

    @Override
    public void close() {
        close(null);
    }
}
